Skip to content

fix typo in the doc of loc_frame#1963

Merged
wanghan-iapcm merged 3 commits into
deepmodeling:develfrom
amcadmus:fix-1962
Oct 4, 2022
Merged

fix typo in the doc of loc_frame#1963
wanghan-iapcm merged 3 commits into
deepmodeling:develfrom
amcadmus:fix-1962

Conversation

@amcadmus

@amcadmus amcadmus commented Oct 3, 2022

Copy link
Copy Markdown
Member

fixes #1962

@amcadmus amcadmus requested a review from njzjz October 3, 2022 01:51
@github-actions github-actions Bot added the Python label Oct 3, 2022
@codecov-commenter

codecov-commenter commented Oct 3, 2022 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Base: 64.07% // Head: 64.07% // No change to project coverage 👍

Coverage data is based on head (8850a97) compared to base (7eb5bda).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@           Coverage Diff           @@
##            devel    #1963   +/-   ##
=======================================
  Coverage   64.07%   64.07%           
=======================================
  Files         181      181           
  Lines       16558    16558           
=======================================
  Hits        10610    10610           
  Misses       5948     5948
Impacted Files Coverage Δ
deepmd/descriptor/loc_frame.py 96.21% <ø> (ø)
deepmd/utils/argcheck.py 90.20% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@njzjz

njzjz commented Oct 3, 2022

Copy link
Copy Markdown
Member

Changes should be synced here:

deepmd-kit/deepmd/utils/argcheck.py

Lines 106 to 112 in 923b98c

doc_axis_rule = 'A list of integers. The length should be 6 times of the number of types. \n\n\
- axis_rule[i*6+0]: class of the atom defining the first axis of type-i atom. 0 for neighbors with full coordinates and 1 for neighbors only with relative distance.\n\n\
- axis_rule[i*6+1]: type of the atom defining the first axis of type-i atom.\n\n\
- axis_rule[i*6+2]: index of the axis atom defining the first axis. Note that the neighbors with the same class and type are sorted according to their relative distance.\n\n\
- axis_rule[i*6+3]: class of the atom defining the first axis of type-i atom. 0 for neighbors with full coordinates and 1 for neighbors only with relative distance.\n\n\
- axis_rule[i*6+4]: type of the atom defining the second axis of type-i atom.\n\n\
- axis_rule[i*6+5]: class of the atom defining the second axis of type-i atom. 0 for neighbors with full coordinates and 1 for neighbors only with relative distance.'

@wanghan-iapcm wanghan-iapcm enabled auto-merge (squash) October 4, 2022 13:48
@wanghan-iapcm wanghan-iapcm merged commit d2f52c7 into deepmodeling:devel Oct 4, 2022
@njzjz njzjz linked an issue Oct 27, 2022 that may be closed by this pull request
axis_rule of local_frame #1962
Closed
@njzjz njzjz mentioned this pull request Oct 27, 2022
Closed
mingzhong15 pushed a commit to mingzhong15/deepmd-kit that referenced this pull request Jan 15, 2023
@amcadmus @wanghan-iapcm @mingzhong15
fix typo in the doc of loc_frame (deepmodeling#1963)
d1c05fa 
fixes deepmodeling#1962

Co-authored-by: Han Wang <wang_han@iapcm.ac.cn>
Co-authored-by: Han Wang <92130845+wanghan-iapcm@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@njzjz njzjz njzjz approved these changes

Assignees

No one assigned

Labels

Python

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

axis_rule of local_frame

4 participants

@amcadmus @codecov-commenter @njzjz @wanghan-iapcm